Clarify path for a simple body_text event. (#1705)
* Clarify path for a simple body_text event.
It's not really clear with regard to a normal agent that this is simply the name of the field.
* updated text
bobbysteel
1 changed files with 1 additions and 1 deletions
+ 1
- 1
app/models/agents/trigger_agent.rb
@@ -8,7 +8,7 @@ module Agents |
||
| 8 | 8 |
description <<-MD |
| 9 | 9 |
The Trigger Agent will watch for a specific value in an Event payload. |
| 10 | 10 |
|
| 11 |
- The `rules` array contains hashes of `path`, `value`, and `type`. The `path` value is a dotted path through a hash in [JSONPaths](http://goessner.net/articles/JsonPath/) syntax. |
|
| 11 |
+ The `rules` array contains hashes of `path`, `value`, and `type`. The `path` value is a dotted path through a hash in [JSONPaths](http://goessner.net/articles/JsonPath/) syntax. For simple events, this is usually just the name of the field you want, like 'text' for the text key of the event. |
|
| 12 | 12 |
|
| 13 | 13 |
The `type` can be one of #{VALID_COMPARISON_TYPES.map { |t| "`#{t}`" }.to_sentence} and compares with the `value`. Note that regex patterns are matched case insensitively. If you want case sensitive matching, prefix your pattern with `(?-i)`.
|
| 14 | 14 |
|